Skip to main content
PUT
[Monitors] Update instance monitor

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

id
string<uuid>
required

A UUID string identifying this Instance.

monitor_id
string
required

Unique identifier of the monitor.

organization_id
string<uuid>
required
project_id
string<uuid>
required

Body

application/json
name
string
required
Maximum string length: 255
monitor_type
enum<string>
required
  • ping - Ping
  • port - Port
Available options:
ping,
port
port
integer<int64> | null
Required range: 0 <= x <= 4294967295
protocol
enum<string>
  • tcp - TCP
  • udp - UDP
Available options:
tcp,
udp
interval_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
timeout_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
retries
integer<int64>
Required range: 0 <= x <= 4294967295
is_enabled
boolean
location_id
string<uuid> | null

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
monitor_type
enum<string>
required
  • ping - Ping
  • port - Port
Available options:
ping,
port
target
string | null
required
read-only
location
object
required
status
enum<string>
required
read-only
  • up - Up
  • down - Down
  • degraded - Degraded
  • pending - Pending
Available options:
up,
down,
degraded,
pending
last_check_at
string<date-time> | null
required
read-only
last_latency_ms
string | null
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
consecutive_failures
integer
required
read-only
created
string<date-time>
required
read-only
modified
string<date-time>
required
read-only
port
integer<int64> | null
Required range: 0 <= x <= 4294967295
protocol
enum<string>
  • tcp - TCP
  • udp - UDP
Available options:
tcp,
udp
interval_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
timeout_seconds
integer<int64>
Required range: 0 <= x <= 4294967295
retries
integer<int64>
Required range: 0 <= x <= 4294967295
is_enabled
boolean